Documentation

IRepositorioAdapter
in

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

Funciona como Adaptador de distintos tipos de repositorio para la aplicación.

Table of Contents

Methods

__construct()  : mixed
Constructor de repositorio.
__destruct()  : mixed
Destruye el objeto desconectando del repositorio si es necesario.
conecta()  : bool
Conecta al repositorio
desconecta()  : mixed
Desconecta del repositorio.
getCampos()  : array<string|int, mixed>
Devuelve los posibles campos de filtro del repositorio.
getDocument()  : mixed
Recupera el documento indicado (Recupera del repositorio)
getDocumentIcon()  : object
Devuelve el icono del documento o tipo de documento indicado
getDocumentInfo()  : object|null
Devuelve información del documento indicado
getDocuments()  : array<string|int, mixed>
Devuelve información de los documentos del repositorio que cumplen los campos de filtro.
getInfo()  : object|null|array<string|int, mixed>
Recupera información posible del repositorio.
selectDocumentID()  : bool
Permite seleccionar un documento con ID indicado
validaConexion()  : bool
Valida si se está conectado al repositorio.

Methods

__construct()

Constructor de repositorio.

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

ID del repositorio

$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)

__destruct()

Destruye el objeto desconectando del repositorio si es necesario.

public __destruct() : mixed

conecta()

Conecta al repositorio

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

getCampos()

Devuelve los posibles campos de filtro del repositorio.

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

Array de campos por los que es posible filtrar en el repositorio

getDocument()

Recupera el documento indicado (Recupera del repositorio)

public getDocument(string $idDocumento) : mixed
Parameters
$idDocumento : string

ID del documento a recuperar

Return values
mixed —

El fichero con ID indicado.

getDocumentIcon()

Devuelve el icono del documento o tipo de documento indicado

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

ID del documento a recuperar

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 —

Información del documento o null si no existe.

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, mixed>
Parameters
$camposFiltro : array<string|int, mixed>

Array asociativo con campos => valores para filtrar.

Return values
array<string|int, mixed> —

Array de FileUserData con información de ficheros.

getInfo()

Recupera información posible del repositorio.

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

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

selectDocumentID()

Permite seleccionar un documento con ID indicado

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

El ID del documento a seleccionar

Return values
bool

validaConexion()

Valida si se está conectado al repositorio.

public validaConexion() : bool
Return values
bool —

True si se está conectado al repositorio.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results