LibreDTE

Document
in package
implements DocumentInterface

Clase que representa un documento que se enviará en un sobre.

Contiene el documento y los metadatos de dicho documento.

Table of Contents

Interfaces

DocumentInterface
Interfaz para la clase que representa un documento que se enviará en un sobre.

Properties

$attachments  : array<string|int, AttachmentInterface>
Listado de archivos adjuntos que se enviarán junto al documento.
$content  : string
Datos del documento que se está intercambiando.
$metadata  : BagInterface
Metadatos del documento.
$type  : DocumentType
Tipo del documento.

Methods

__construct()  : mixed
Constructor del documento que se está intercambiando.
addAttachment()  : static
Agrega un archivo adjunto al documento.
addMetadata()  : static
Agrega una clave específica a los metadatos.
getAttachments()  : array<string|int, AttachmentInterface>
Obtiene el listado de archivos adjuntos al documento.
getContent()  : string
Obtiene el contenido del documento que se está intercambiando.
getContentSize()  : int
Obtiene el tamaño del contenido en bytes.
getID()  : string
Obtiene el identificador único del documento.
getMetadata()  : BagInterface
Obtiene los metadatos del documento.
getType()  : DocumentType
Obtiene el tipo del documento.
setMetadata()  : static
Asigna los metadatos del documento.

Properties

$attachments

Listado de archivos adjuntos que se enviarán junto al documento.

private array<string|int, AttachmentInterface> $attachments

$content

Datos del documento que se está intercambiando.

private string $content

Típicamente será el XML de un documento tributario electrónico (DTE).

$metadata

Metadatos del documento.

private BagInterface $metadata

Estos metadatos están directamente relacionados con el documento que se está intercambiando y el tipo de transporte que se esté usando para dicho intercambio.

Methods

__construct()

Constructor del documento que se está intercambiando.

public __construct([string $content = '' ][, array<string|int, AttachmentInterface$attachments = [] ][, DocumentType $type = DocumentType::B2B ][, BagInterface|array<string|int, mixed> $metadata = [] ]) : mixed
Parameters
$content : string = ''
$attachments : array<string|int, AttachmentInterface> = []
$type : DocumentType = DocumentType::B2B
$metadata : BagInterface|array<string|int, mixed> = []

addMetadata()

Agrega una clave específica a los metadatos.

public addMetadata(string $key, mixed $value) : static
Parameters
$key : string
$value : mixed
Return values
static

getContent()

Obtiene el contenido del documento que se está intercambiando.

public getContent() : string
Return values
string

getContentSize()

Obtiene el tamaño del contenido en bytes.

public getContentSize() : int
Return values
int

getID()

Obtiene el identificador único del documento.

public getID() : string
Return values
string

getMetadata()

Obtiene los metadatos del documento.

public getMetadata() : BagInterface
Return values
BagInterface

setMetadata()

Asigna los metadatos del documento.

public setMetadata(BagInterface|array<string|int, mixed> $metadata) : static
Parameters
$metadata : BagInterface|array<string|int, mixed>
Return values
static

        
On this page

Search results