Documentation

RepoAdapterDW
in package
implements IRepositorioAdapter

Clase implementa acceso a ficheros archivadores Docuware Extiende IRepositorioAdaptar

Table of Contents

Interfaces

IRepositorioAdapter
Interface que permite conectarse y gestionar repositorios Implementar este interfaz permitiría conectarse a distintos tipos de repositorios.

Properties

$idArchivador  : mixed
$idRepo  : mixed
$login  : mixed
$pass  : mixed
$token  : mixed
$tokenExpiresTime  : mixed
$url  : mixed

Methods

__construct()  : mixed
Constructor de repositorio.
__destruct()  : mixed
Desconecta del repositorio (llama a desconecta()) y destruye el objeto.
conecta()  : bool
Conecta a repositorio Docuware y obtiene token Oauth2
desconecta()  : mixed
Desconecta del repositorio.
getCampos()  : array<string|int, mixed>
Devuelve los campos accesibles del Archivador
getDocument()  : string
Recupera el documento con ID indicado.
getDocumentIcon()  : object
Recupera el icono del documento con ID pasado
getDocumentInfo()  : object|null
Devuelve información del documento indicado
getDocuments()  : array<string|int, FileUserData>
Devuelve información de los documentos del repositorio que cumplen los campos de filtro.
getInfo()  : object|null|array<string|int, mixed>
Devuelve información del archivador Docuware conectado.
selectDocumentID()  : bool
Selecciona el documento con ID indicado TODO: Pendiente implementar
validaConexion()  : bool
Valida la conexión a repositorio.
downloadDocument()  : mixed
Descarga -y devuelve el contenido- del documento con ID pasado
getFileCabinetInformation()  : mixed
Devuelve información del archivador conectado
getIdArchivador()  : string
Recupera el ID de archivador Docuware donde están los documentos.
GetIdentityServiceConfiguration()  : mixed
Maneja configuración de identificación y devuelve la url para solicitar tokens Oauth2
getIdRepo()  : int
Recupera el ID del repositorio
getLogin()  : string
Recupera el login empleado para acceso a tenant Docuware
getOrganization()  : mixed
Devuelve información de la Organización almacenada en Docuware
getPass()  : string
Recupera la contraseña de acceso a tenant Docuware
GetResponsibleIdentityService()  : string
Devuelve la URL responsable de identificación del sistema Docuware
getSpecificDocumentFromFileCabinet()  : object|null
Devuelve información de un documento específico.
getToken()  : string
Recupera el Token de acceso OAuth empleado.
getUrl()  : string
Recupera la URL del repositorio
getUrlPlatform()  : string
Recupera la URL completa
RequestTokenWUsernamePassword()  : mixed
Solicita un token de identificación Oauth en la url indicada
searchDocumentsSingleFileCabinet()  : mixed
Devuelve los documentos del archivador con una búsqueda conforme el json enviado Json ejemplo: { "Condition":[ {"DBName":"COMPANY_NAME", "Value":["US-Steel"]}, {"DBName":"DOCUMENT_DATE", "Value":["2010-03-01", "2010-03-30"]} ], "Operation":"Or" }
setIdArchivador()  : mixed
Actualiza el ID del archivador donde se encuentran los documentos.
setIdRepo()  : mixed
actualiza el ID del repositorio
setLogin()  : mixed
Actualiza el login empleado para acceder al repositorio
setPass()  : mixed
Actualiza la contraseña empleada para acceder al repositorio
setToken()  : mixed
Actualiza el Token empleado para acceso OAuth a Docuware
setUrl()  : mixed
Actualiza la URL del repositorio (formato: https://MISUBDOMINIO.docuware.cloud)

Properties

Methods

__construct()

Constructor de repositorio.

public __construct(int $idRepo, string $url[, string $login = null ][, string $pass = null ][, mixed $extra = null ]) : mixed
Parameters
$idRepo : int

ID del repositorio

$url : string
$login : string = null

Login empleado para acceder al repositorio (o null)

$pass : string = null

Contraseña empleada para acceder al repositorio (o null)

$extra : mixed = null

GUID Archivador documentos

__destruct()

Desconecta del repositorio (llama a desconecta()) y destruye el objeto.

public __destruct() : mixed

conecta()

Conecta a repositorio Docuware y obtiene token Oauth2

public conecta(string $direccion[, string $login = null ][, string $pass = null ][, mixed $extra = null ]) : bool
Parameters
$direccion : string

Dirección / URL del repositorio

$login : string = null

Login empleado para acceder al repositorio (o null)

$pass : string = null

Contraseña empleada para acceder al repositorio (o null)

$extra : mixed = null

Datos adicionales para acceso a repositorio (ID Biblioteca, etc.) (o null)

Return values
bool —

true si conecta correctamente y obtiene token. False en caso contrario.

desconecta()

Desconecta del repositorio.

public desconecta() : mixed

getCampos()

Devuelve los campos accesibles del Archivador

public getCampos() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Array con los campos del Archivador al que está conectado.

getDocument()

Recupera el documento con ID indicado.

public getDocument(string $idDocumento) : string
Parameters
$idDocumento : string
Return values
string —

Dirección de archivo temporal (tmpfile()) donde se guardó el fichero desde el repositorio.

getDocumentIcon()

Recupera el icono del documento con ID pasado

public getDocumentIcon(string $idDocumento) : object
Parameters
$idDocumento : string

TODO: Pendiente implementar.

Return values
object —

Icono del documento.

getDocumentInfo()

Devuelve información del documento indicado

public getDocumentInfo(string $idDocumento) : object|null
Parameters
$idDocumento : string

ID del documento a recuperar

Return values
object|null —

Objeto con campos que son información del documento o null si no es posible recuperarla.

getDocuments()

Devuelve información de los documentos del repositorio que cumplen los campos de filtro.

public getDocuments(array<string|int, mixed> $camposFiltro) : array<string|int, FileUserData>
Parameters
$camposFiltro : array<string|int, mixed>

Array asociativo con campos => valores para filtrar.

Return values
array<string|int, FileUserData> —

Array de FileUserData con información de ficheros.

getInfo()

Devuelve información del archivador Docuware conectado.

public getInfo() : object|null|array<string|int, mixed>

Devuelve nombre de la organización a la que está conectado.

Return values
object|null|array<string|int, mixed> —

(La información posible no está definida, distintos repositorios podrían devolver información diferente)

selectDocumentID()

Selecciona el documento con ID indicado TODO: Pendiente implementar

public selectDocumentID(string $idDocumento) : bool
Parameters
$idDocumento : string

El ID del documento a seleccionar

Return values
bool

validaConexion()

Valida la conexión a repositorio.

public validaConexion() : bool
Return values
bool —

True si está conectado

downloadDocument()

Descarga -y devuelve el contenido- del documento con ID pasado

private downloadDocument(int $idDoc) : mixed
Parameters
$idDoc : int

ID del documento en repositorio Docuware

getFileCabinetInformation()

Devuelve información del archivador conectado

private getFileCabinetInformation() : mixed

getIdArchivador()

Recupera el ID de archivador Docuware donde están los documentos.

private getIdArchivador() : string
Return values
string —

ID del archivador

GetIdentityServiceConfiguration()

Maneja configuración de identificación y devuelve la url para solicitar tokens Oauth2

private GetIdentityServiceConfiguration(mixed $IdentityServiceUrl) : mixed
Parameters
$IdentityServiceUrl : mixed
Tags
Param

string IdentityServiceUrl

getIdRepo()

Recupera el ID del repositorio

private getIdRepo() : int
Return values
int —

ID del repositorio

getLogin()

Recupera el login empleado para acceso a tenant Docuware

private getLogin() : string
Return values
string —

Login de acceso a repositorio Docuware

getOrganization()

Devuelve información de la Organización almacenada en Docuware

private getOrganization() : mixed

getPass()

Recupera la contraseña de acceso a tenant Docuware

private getPass() : string
Return values
string —

Contraseña de acceso a repositorio

GetResponsibleIdentityService()

Devuelve la URL responsable de identificación del sistema Docuware

private GetResponsibleIdentityService() : string
Return values
string —

URL de identificación del tenant Docuware

getSpecificDocumentFromFileCabinet()

Devuelve información de un documento específico.

private getSpecificDocumentFromFileCabinet(int $idDoc) : object|null
Parameters
$idDoc : int

ID del documento en archivador Docuware.

Return values
object|null

getToken()

Recupera el Token de acceso OAuth empleado.

private getToken() : string
Return values
string —

Token de acceso OAuth

getUrl()

Recupera la URL del repositorio

private getUrl() : string
Return values
string —

URL de tenant Docuware (formato: https://MISUBDOMINIO.docuware.cloud)

getUrlPlatform()

Recupera la URL completa

private getUrlPlatform() : string
Return values
string —

URL completa de la plataforma Docuware (incluyendo /Docuware/Platform)

RequestTokenWUsernamePassword()

Solicita un token de identificación Oauth en la url indicada

private RequestTokenWUsernamePassword(string $TokenEndpoint) : mixed
Parameters
$TokenEndpoint : string

URL donde gestionar token Oauth.

searchDocumentsSingleFileCabinet()

Devuelve los documentos del archivador con una búsqueda conforme el json enviado Json ejemplo: { "Condition":[ {"DBName":"COMPANY_NAME", "Value":["US-Steel"]}, {"DBName":"DOCUMENT_DATE", "Value":["2010-03-01", "2010-03-30"]} ], "Operation":"Or" }

private searchDocumentsSingleFileCabinet(string $jsonConsulta) : mixed
Parameters
$jsonConsulta : string

setIdArchivador()

Actualiza el ID del archivador donde se encuentran los documentos.

private setIdArchivador(string $idArchivador) : mixed
Parameters
$idArchivador : string

setIdRepo()

actualiza el ID del repositorio

private setIdRepo(int $idRepo) : mixed
Parameters
$idRepo : int

ID del repositorio

setLogin()

Actualiza el login empleado para acceder al repositorio

private setLogin(string $login) : mixed
Parameters
$login : string

setPass()

Actualiza la contraseña empleada para acceder al repositorio

private setPass(string $pass) : mixed
Parameters
$pass : string

setToken()

Actualiza el Token empleado para acceso OAuth a Docuware

private setToken(string|null $token, int $validSecs) : mixed
Parameters
$token : string|null

Token empleado

$validSecs : int

Número de segundos que quedan para ser válido.

setUrl()

Actualiza la URL del repositorio (formato: https://MISUBDOMINIO.docuware.cloud)

private setUrl(string $url) : mixed
Parameters
$url : string

del repositorio


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results