WSCOMUN  2.1.0
Web Services Comunes para PHP/GVHidra
Métodos públicos | Campos de datos
Referencia de la Clase WSClientGDE2
Diagrama de herencias de WSClientGDE2
WSComunFClient

Métodos públicos

 insertarDocumento ($codApp, $docContentB64, $nombreDoc, $pathDoc=null, $tipo=null, $vMetadatosENI=null, $vMetadatosPersonalizados=null, $vFirmas=null)
 
 obtenerDocumento ($codApp, $refDoc, $parcial='1')
 
 eliminarDocumento ($codApp, $refDoc)
 
 asociarFirmas ($codApp, $refDoc, $vFirmas)
 
 buscarDocCriterio ($codApp, $filtroPath=null, $buscarInTree=null, $operacion=null, $coleccionCriterios=null)
 
 buscarDocCriterioPaginado ($codApp, $registrosPagina, $pagina, $filtroPath=null, $buscarInTree=null, $operacion=null, $coleccionCriterios=null)
 
 crearCarpeta ($codApp, $path, $tipo=null, $metadatosExpedienteEni=null, $coleccionMetadatosPersonalizados=null)
 
 eliminarCarpeta ($codApp, $path)
 
 empaquetarDocumentoENI ($codApp, $contenido, $vMetadatosEni, $vFirmas)
 
 establecerMetadatoCarpetasPersonalizados ($codApp, $path, $vColMetadatosPers)
 
 establecerMetadatosCarpetaExpedienteENI ($codApp, $path, $vMetadatosExpedienteEni)
 
 establecerMetadatosENI ($codApp, $refDoc, $vMetadatosEni)
 
 establecerMetadatosPersonalizados ($codApp, $refDoc, $coleccionMetadatosPersonalizados)
 
 generarIdentificadorENI ($codApp)
 
 generarToken ($codApp, $vRefDoc)
 
 insertarDocumentoENI ($codApp, $docContentB64, $nombreDoc, $pathDoc=null, $tipo=null, $vMetaENI=null, $vMetaPers=null, $vFirmas=null)
 
 obtenerDocumentoENI ($codApp, $refDoc)
 
 obtenerExpedienteENI ($codApp, $refDoc, $vMetadatosExpedienteEni, $idCertificadoSafe=null, $idSesionSafe=null)
 
 obtenerExpedienteENIdeCarpeta ($codApp, $path, $idCertificadoSafe=null, $idSesionSafe=null)
 
 moverDocumento ($codApp, $refDoc, $pathDestino)
 
 actualizarDocumento ($codApp, $refDoc, $docContentB64, $vFirmas=null)
 
 obtenerListaVersionesDocumento ($codApp, $refDoc)
 
 restaurarVersionDocumento ($codApp, $refDoc, $version, $parcial)
 
 obtenerPathDocumento ($codApp, $refDoc)
 
 eliminarCarpetaRecursiva ($codApp, $path)
 
 moverCarpeta ($codApp, $pathOrigen, $pathDestino)
 
 obtenerVersionDocumento ($codApp, $refDoc, $parcial, $version)
 
 front_obtenerDocumentoAPartirDeToken ($esProduccion, $token)
 
 front_obtenerIdentificadorGDE ($esProduccion, $codApp, $refDoc)
 
 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)
 
- 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)
 

Campos de datos

const URL_FRONT_DESARROLLO = 'https://previs.gva.es/gde-front/'
 
const URL_FRONT_PRODUCCION = 'https://www.tramita.gva.es/gde-front/'
 
- 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 KEYCLIENTE_REGDEPARTAMENTAL = 'regdepartamental'
 
const TIPOBUSQUEDA_USUARIO = 'USUARIO'
 
const TIPOBUSQUEDA_GRUPO = 'GRUPO'
 

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 ()
 
- 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
 
 $userToken = ''
 
 $passUserToken = ''
 
 $enableTrazabilidadPAI = true
 
 $enableWSSecurity = 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'
 
static $NAMESPACE_REGDEPARTAMENTAL = 'urn:es:gva:mastin:departamental:model'
 

Descripción detallada

Definición en la línea 15 del archivo WSClientGDE2.php.

Documentación de las funciones miembro

◆ actualizarDocumento()

actualizarDocumento (   $codApp,
  $refDoc,
  $docContentB64,
  $vFirmas = null 
)

Permite actualizar un documento ya existente. Se generarán dos versiones, una que contendrá una copia exacta de la versión anterior y una segunda copia que será la versión modificada, cuyo número de versión será devuelto en la respuesta

GDE2

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia del documento
string$docContentB64Contenido del documento en Base64
array$vFirmasOpcional. Array asociativo. Firmas
Devuelve
array Respuesta del servicio, indicando el número de versión generada public

Definición en la línea 1374 del archivo WSClientGDE2.php.

◆ asociarFirmas()

asociarFirmas (   $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 280 del archivo WSClientGDE2.php.

◆ asociarFirmasGDE2()

asociarFirmasGDE2 (   $codApp,
  $refDoc,
  $vFirmas 
)

[Obsoleto] Véase: asociarFirmas 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 1847 del archivo WSClientGDE2.php.

◆ buscarDocCriterio()

buscarDocCriterio (   $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 354 del archivo WSClientGDE2.php.

◆ buscarDocCriterioGDE2()

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

[Obsoleto] Véase: buscarDocCriterio 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 1871 del archivo WSClientGDE2.php.

◆ buscarDocCriterioPaginado()

buscarDocCriterioPaginado (   $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.
int$registrosPaginaNúmero de regitros por página
int$paginaPágina a recuperar (empezando por 1)
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 operación lógica (AND/OR)
array$coleccionCriteriosColección de criterios de búsqueda

Definición en la línea 425 del archivo WSClientGDE2.php.

◆ buscarDocCriterioPaginadoGDE2()

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

[Obsoleto] Véase: buscarDocCriterioPaginado 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.
int$registrosPaginaNúmero de regitros por página
int$paginaPágina a recuperar (empezando por 1)
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 operación lógica (AND/OR)
array$coleccionCriteriosColección de criterios de búsqueda

Definición en la línea 1894 del archivo WSClientGDE2.php.

◆ crearCarpeta()

crearCarpeta (   $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 488 del archivo WSClientGDE2.php.

◆ crearCarpetaGDE2()

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

[Obsoleto] Véase: crearCarpeta 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 1910 del archivo WSClientGDE2.php.

◆ eliminarCarpeta()

eliminarCarpeta (   $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
object

Definición en la línea 540 del archivo WSClientGDE2.php.

◆ eliminarCarpetaGDE2()

eliminarCarpetaGDE2 (   $codApp,
  $path 
)

[Obsoleto] Véase: eliminarCarpeta 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
object

Definición en la línea 1923 del archivo WSClientGDE2.php.

◆ eliminarCarpetaRecursiva()

eliminarCarpetaRecursiva (   $codApp,
  $path 
)

Permite eliminar de forma recursiva una carpeta

GDE2

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$pathRuta relativa de la carpeta que queremos borrar. La ruta introducida buscará a partir del directorio root_custom
Devuelve
array Respuesta del servicio indicando la correccion de la operacion public

Definición en la línea 1574 del archivo WSClientGDE2.php.

◆ eliminarDocumento()

eliminarDocumento (   $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 188 del archivo WSClientGDE2.php.

◆ eliminarDocumentoGDE2()

eliminarDocumentoGDE2 (   $codApp,
  $refDoc 
)

[Obsoleto] Véase: eliminarDocumento [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 1832 del archivo WSClientGDE2.php.

◆ empaquetarDocumentoENI()

empaquetarDocumentoENI (   $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 607 del archivo WSClientGDE2.php.

◆ empaquetarDocumentoENIGDE2()

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

[Obsoleto] Véase: empaquetarDocumentoENI 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 1938 del archivo WSClientGDE2.php.

◆ establecerMetadatoCarpetasPersonalizados()

establecerMetadatoCarpetasPersonalizados (   $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
object

Definición en la línea 671 del archivo WSClientGDE2.php.

◆ establecerMetadatoCarpetasPersonalizadosGDE2()

establecerMetadatoCarpetasPersonalizadosGDE2 (   $codApp,
  $path,
  $vColMetadatosPers 
)

[Obsoleto] Véase: establecerMetadatoCarpetasPersonalizados 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
object

Definición en la línea 1952 del archivo WSClientGDE2.php.

◆ establecerMetadatosCarpetaExpedienteENI()

establecerMetadatosCarpetaExpedienteENI (   $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
string$path
array$vMetadatosExpedienteEni

Definición en la línea 731 del archivo WSClientGDE2.php.

◆ establecerMetadatosCarpetaExpedienteENIGDE2()

establecerMetadatosCarpetaExpedienteENIGDE2 (   $codApp,
  $path,
  $vMetadatosExpedienteEni 
)

[Obsoleto] Véase: establecerMetadatosCarpetaExpedienteENI 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
string$path
array$vMetadatosExpedienteEni

Definición en la línea 1964 del archivo WSClientGDE2.php.

◆ establecerMetadatosENI()

establecerMetadatosENI (   $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
string$refDoc
array$vMetadatosEni

Definición en la línea 797 del archivo WSClientGDE2.php.

◆ establecerMetadatosENIGDE2()

establecerMetadatosENIGDE2 (   $codApp,
  $refDoc,
  $vMetadatosEni 
)

[Obsoleto] Véase: establecerMetadatosENI 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
string$refDoc
array$vMetadatosEni

Definición en la línea 1980 del archivo WSClientGDE2.php.

◆ establecerMetadatosPersonalizados()

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

Definición en la línea 860 del archivo WSClientGDE2.php.

◆ establecerMetadatosPersonalizadosGDE2()

establecerMetadatosPersonalizadosGDE2 (   $codApp,
  $refDoc,
  $coleccionMetadatosPersonalizados 
)

[Obsoleto] Véase: establecerMetadatosPersonalizados

Parámetros
string$codApp
string$refDocreferencia GDE
array$coleccionMetadatosPersonalizados

Definición en la línea 1993 del archivo WSClientGDE2.php.

◆ front_obtenerDocumentoAPartirDeToken()

front_obtenerDocumentoAPartirDeToken (   $esProduccion,
  $token 
)

Devuelve una URL en la que obtener el documento a partir del token suministrado

GDE2

Parámetros
bool$esProduccionIndica si debe realizarse la peticion al servidor de produccion o al servidor de desarrollo/preproduccion
string$tokenToken válido para la descarga del documento
Devuelve
string URL parametrizada a la que realizar la consulta public

Definición en la línea 1737 del archivo WSClientGDE2.php.

◆ front_obtenerIdentificadorGDE()

front_obtenerIdentificadorGDE (   $esProduccion,
  $codApp,
  $refDoc 
)

Devuelve una URL en la que obtener un identificador GDE y la ruta a su directorio raíz La URL resultante devolverá una cadena con los dos valores con el separador ‘##’: idGDE##path_root

GDE2

Parámetros
bool$esProduccionIndica si debe realizarse la peticion al servidor de produccion o al servidor de desarrollo/preproduccion
string$codAppNombre del espacio de la aplicacion
string$refDocReferencia del documento
Devuelve
string URL parametrizada a la que realizar la consulta public

Definición en la línea 1759 del archivo WSClientGDE2.php.

◆ generarIdentificadorENI()

generarIdentificadorENI (   $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 920 del archivo WSClientGDE2.php.

◆ generarIdentificadorENIGDE2()

generarIdentificadorENIGDE2 (   $codApp)

[Obsoleto] Véase: generarIdentificadorENI 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 2004 del archivo WSClientGDE2.php.

◆ generarToken()

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

Definición en la línea 977 del archivo WSClientGDE2.php.

◆ generarTokenGDE2()

generarTokenGDE2 (   $codApp,
  $vRefDoc 
)

[Obsoleto] Véase: generarToken

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

Definición en la línea 2016 del archivo WSClientGDE2.php.

◆ insertarDocumento()

insertarDocumento (   $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 46 del archivo WSClientGDE2.php.

◆ insertarDocumentoENI()

insertarDocumentoENI (   $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 1046 del archivo WSClientGDE2.php.

◆ insertarDocumentoENIGDE2()

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

[Obsoleto] Véase: insertarDocumentoENI 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 2036 del archivo WSClientGDE2.php.

◆ insertarDocumentoGDE2()

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

[Obsoleto] Véase: insertarDocumento 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 1798 del archivo WSClientGDE2.php.

◆ moverCarpeta()

moverCarpeta (   $codApp,
  $pathOrigen,
  $pathDestino 
)

Permite, mover o renombrar una carpeta. Las rutas siempre se buscarán y se crearán en root_custom

GDE2

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$pathOrigenRuta relativa de la carpeta que queremos mover o renombrar
string$pathDestinoRuta relativa de la carpeta que queremos mover o renombrar
Devuelve
array Respuesta del servicio indicando la correccion de la operacion public

Definición en la línea 1625 del archivo WSClientGDE2.php.

◆ moverDocumento()

moverDocumento (   $codApp,
  $refDoc,
  $pathDestino 
)

Este método mueve el documento especificado a otra carpeta. Si la nueva carpeta no existe, la crea. Mueve tanto el documento, como las firmas de éste.

GDE2

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia del documento
string$pathDestinoPath relativo con respecto al espacio raíz de la app
Devuelve
array Respuesta del servicio indicando la correccion de la operacion public

Definición en la línea 1318 del archivo WSClientGDE2.php.

◆ obtenerDocumento()

obtenerDocumento (   $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 112 del archivo WSClientGDE2.php.

◆ obtenerDocumentoENI()

obtenerDocumentoENI (   $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 1104 del archivo WSClientGDE2.php.

◆ obtenerDocumentoENIGDE2()

obtenerDocumentoENIGDE2 (   $codApp,
  $refDoc 
)

[Obsoleto] Véase: obtenerDocumentoENI 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 2049 del archivo WSClientGDE2.php.

◆ obtenerDocumentoGDE2()

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

[Obsoleto] Véase: obtenerDocumento [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 1816 del archivo WSClientGDE2.php.

◆ obtenerExpedienteENI()

obtenerExpedienteENI (   $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 1177 del archivo WSClientGDE2.php.

◆ obtenerExpedienteENIdeCarpeta()

obtenerExpedienteENIdeCarpeta (   $codApp,
  $path,
  $idCertificadoSafe = null,
  $idSesionSafe = null 
)
Parámetros
string$codAppCódigo del espacio de aplicación invocante (espacio)
string$path
string$idCertificadoSafe
string$idSesionSafe
Devuelve
object|array

Definición en la línea 1240 del archivo WSClientGDE2.php.

◆ obtenerExpedienteENIdeCarpetaGDE2()

obtenerExpedienteENIdeCarpetaGDE2 (   $codApp,
  $path,
  $idCertificadoSafe = null,
  $idSesionSafe = null 
)

[Obsoleto] Véase: obtenerExpedienteENIdeCarpeta

Parámetros
string$codAppCódigo del espacio de aplicación invocante (espacio)
string$path
string$idCertificadoSafe
string$idSesionSafe
Devuelve
object|array

Definición en la línea 2085 del archivo WSClientGDE2.php.

◆ obtenerExpedienteENIGDE2()

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

[Obsoleto] Véase: obtenerExpedienteENI 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 2071 del archivo WSClientGDE2.php.

◆ obtenerListaVersionesDocumento()

obtenerListaVersionesDocumento (   $codApp,
  $refDoc 
)

Permite obtener una lista de etiquetas con las versiones guardadas del documento

GDE2

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia del documento
Devuelve
array Respuesta del servicio, indicando la lista de versiones del documento public

Definición en la línea 1419 del archivo WSClientGDE2.php.

◆ obtenerPathDocumento()

obtenerPathDocumento (   $codApp,
  $refDoc 
)

Permite, a partir de una referencia de documento, obtener la ruta del documento en el espacio asignado a la aplicación propietaria. El path del documento, debe estar dentro de root_custom.

GDE2

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia del documento
Devuelve
array Respuesta del servicio, indicando la ruta relativa del documento a partir del espacio "root_custom” de la aplicación public

Definición en la línea 1524 del archivo WSClientGDE2.php.

◆ obtenerVersionDocumento()

obtenerVersionDocumento (   $codApp,
  $refDoc,
  $parcial,
  $version 
)

Accede al doc y devuelve la información de una version concreta del mismo

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)
string$versionEtiqueta de versión que se quiere recuperar
Devuelve
array Array asociativo [contenido|nombre|tipoPersonalizado|borrado|metadatosENI|metadatosPersonalizados|firmas] public

Definición en la línea 1677 del archivo WSClientGDE2.php.

◆ restaurarVersionDocumento()

restaurarVersionDocumento (   $codApp,
  $refDoc,
  $version,
  $parcial 
)

Permite restaurar una versión concreta del documento. Primero genera una copia exacta de la versión actual del documento y a continuación, recupera la versión especificada añadiéndola como una nueva versión.

GDE2

Parámetros
string$codAppCódigo del espacio de aplicación invocante.
string$refDocReferencia del documento
string$versionEtiqueta de versión que se quiere restaurar
string$parcialIndica que datos recuprar (1: Todo, 2: Contenido y metadatos, 3: Contenido, metadatos y eliminar aquellos metadatos que no estén en la versión restaurada)
Devuelve
array Respuesta del servicio indicando la correccion de la operacion public

Definición en la línea 1473 del archivo WSClientGDE2.php.

Documentación de los campos

◆ URL_FRONT_DESARROLLO

const URL_FRONT_DESARROLLO = 'https://previs.gva.es/gde-front/'

Constantes para URL de consultas al frontend

Definición en la línea 22 del archivo WSClientGDE2.php.


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