Documentation

DacteOS extends DaCommon
in package

Application

Properties

$aereo : mixed
$aFont : array<string|int, mixed>
$aquav : mixed
$arrayNFe : mixed
$cancelFlag : bool
$chaveCTeRef : mixed
$Comp : mixed
$compl : mixed
$creditos : string
$cteProc : mixed
$debugmode : bool
$decimalPlaces : int
$dom : mixed
$emit : mixed
$enderEmit : mixed
$enderToma : mixed
$errMsg : mixed
$errStatus : mixed
$ferrov : mixed
$flagDocOrigContinuacao : mixed
$fontePadrao : string
$formatNegrito : mixed
$formatoChave : mixed
$formatPadrao : mixed
$hPrint : float
$ICMS : mixed
$ICMSSN : mixed
$idDocAntEle : mixed
$ide : mixed
$imp : mixed
$infCarga : mixed
$infCte : mixed
$infCteComp : mixed
$infNF : mixed
$infNFe : mixed
$infOutros : mixed
$infPercurso : mixed
$infQ : mixed
$infServico : mixed
$infTribFed : mixed
$logoAlign : string
$logomarca : string
$lota : mixed
$margemInterna : mixed
$margesq : int
$marginf : int
$margsup : int
$maxH : float
$maxW : float
$modal : mixed
$moto : mixed
$nApol : mixed
$nomeDesenvolvedor : mixed
$numdepec : string
$ObsCont : mixed
$ObsFisco : mixed
$orientacao : string
$papel : string|array<string|int, mixed>
$pdf : Pdf
$powered : bool
$preVisualizar : mixed
$protCTe : mixed
$qrCodMDFe : mixed
$respSeg : mixed
$rodo : mixed
$seg : mixed
$siteDesenvolvedor : mixed
$textoAdic : mixed
$toma : mixed
$toma03 : mixed
$toma4 : mixed
$totPag : mixed
$tpAmb : mixed
$tpCTe : mixed
$tpEmis : mixed
$tpImp : mixed
$veic : mixed
$vPrest : mixed
$wAdic : mixed
$wCanhoto : mixed
$wPrint : float
$xIni : float
$xml : mixed
$xSeg : mixed
$yDados : mixed
$yIni : float

Methods

__construct() : mixed: __construct
creditsIntegratorFooter() : void: Add the credits to the integrator in the footer message
debugMode() : bool: Ativa ou desativa o modo debug
depecNumber() : void: Numero DPEC
logoParameters() : void: Set logo e sua posição
printParameters() : void: Define parametros de impressão
render() : string: Renderiza o pdf e retorna como raw
setCancelFlag() : mixed: Atribui uma sinalização de cancelamento externa
setDefaultDecimalPlaces() : mixed: Seta o numero de casas decimais a serem usadas como padrão
setDefaultFont() : mixed: Seta a fonte padrão é times
toDateTime() : DateTime|false: Converte data da NFe YYYY-mm-ddThh:mm:ss-03:00 para \DateTime
toTimestamp() : int: Converte data da NFe YYYY-mm-ddThh:mm:ss-03:00 para timestamp unix
adjustImage() : string: Ajusta a imagem do logo
cabecalho() : number: cabecalho Monta o cabelhalho da DACTE ( retrato e paisagem )
canhoto() : number: canhoto Monta o campo com os dados do remetente na DACTE.
compValorServ() : number: compValorServ Monta o campo com os componentes da prestação de serviços.
convertUnidTrafego() : string: convertUnidTrafego Converte a imformação de peso contida na CTe
dadosAdic() : number: dadosAdic Coloca o grupo de dados adicionais da DACTE.
docCompl() : number: docCompl Monta o campo com os dados do remetente na DACTE.
formatCNPJCPF() : string: formatCNPJCPF Formata campo CnpjCpf contida na CTe
formatField() : string: Função de formatação de strings onde o cerquilha # é um coringa que será substituido por digitos contidos em campo.
formatFone() : string: formatFone Formata campo fone contida na CTe
geraChaveAdicCont() : string: geraChaveAdicCont
getTagDate() : string: Recupera e reformata a data do padrão da NFe para dd/mm/aaaa
getTagValue() : string: Extrai o valor do node DOM
impostos() : number: impostos Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )
infPrestacaoServico() : number: infPrestacaoServico Monta o campo com das informações da prestação do serviço
modalAereo() : number: modalAereo Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )
modalAquaviario() : number: modalAquaviario Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )
modalFerr() : number: modalFerr Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )
modalRod() : number: modalRod Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )
modulo11() : int: camcula digito de controle modulo 11
monta() : string: montaDACTE Esta função monta a DACTE conforme as informações fornecidas para a classe durante sua construção.
multiUniPeso() : interger: multiUniPeso Fornece a imformação multiplicação de peso contida na CTe
observacoes() : number: observacoes Monta o campo com os dados do remetente na DACTE.
qrCodeDacteOs() : mixed
rodape() : mixed: rodapeDACTE Monta o rodape no final da DACTE ( retrato e paisagem )
seguro() : number: seguro Monta o campo com os dados de seguro do CT-e OS.
statusCTe() : array<string|int, mixed>: Verifica o status da CTe
tipoPag() : mixed
tomador() : number: tomador Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )
unidade() : string: unidade Converte a imformação de peso contida na CTe
ymdTodmy() : string: Converte datas no formato YMD (ex. 2009-11-02) para o formato brasileiro 02/11/2009)
loadDoc() : mixed

$aereo


        protected
            mixed
    $aereo

$aFont


        protected
            array<string|int, mixed>
    $aFont
     = ['font' => 'times', 'size' => 8, 'style' => '']

$aquav


        protected
            mixed
    $aquav

$arrayNFe


        protected
            mixed
    $arrayNFe
     = array()

$cancelFlag


        protected
            bool
    $cancelFlag
     = false

$chaveCTeRef


        protected
            mixed
    $chaveCTeRef

$Comp


        protected
            mixed
    $Comp

$compl


        protected
            mixed
    $compl

$creditos


        protected
            string
    $creditos

$cteProc


        protected
            mixed
    $cteProc

$debugmode


        protected
            bool
    $debugmode

$decimalPlaces


        protected
            int
    $decimalPlaces

$dom


        protected
            mixed
    $dom

$emit


        protected
            mixed
    $emit

$enderEmit


        protected
            mixed
    $enderEmit

$enderToma


        protected
            mixed
    $enderToma

$errMsg


        protected
            mixed
    $errMsg
     = ''

$errStatus


        protected
            mixed
    $errStatus
     = false

$ferrov


        protected
            mixed
    $ferrov

$flagDocOrigContinuacao


        protected
            mixed
    $flagDocOrigContinuacao

$fontePadrao


        protected
            string
    $fontePadrao
     = 'times'

$formatNegrito


        protected
            mixed
    $formatNegrito

$formatoChave


        protected
            mixed
    $formatoChave
     = "#### #### #### #### #### #### #### #### #### #### ####"

$formatPadrao


        protected
            mixed
    $formatPadrao

$hPrint


        protected
            float
    $hPrint

$ICMS


        protected
            mixed
    $ICMS

$ICMSSN


        protected
            mixed
    $ICMSSN

$idDocAntEle


        protected
            mixed
    $idDocAntEle
     = []

$ide


        protected
            mixed
    $ide

$imp


        protected
            mixed
    $imp

$infCarga


        protected
            mixed
    $infCarga

$infCte


        protected
            mixed
    $infCte

$infCteComp


        protected
            mixed
    $infCteComp

$infNF


        protected
            mixed
    $infNF

$infNFe


        protected
            mixed
    $infNFe

$infOutros


        protected
            mixed
    $infOutros

$infPercurso


        protected
            mixed
    $infPercurso

$infQ


        protected
            mixed
    $infQ

$infServico


        protected
            mixed
    $infServico

$infTribFed


        protected
            mixed
    $infTribFed

$logoAlign


        protected
            string
    $logoAlign
     = 'C'

$logomarca


        protected
            string
    $logomarca

$lota


        protected
            mixed
    $lota

$margemInterna


        protected
            mixed
    $margemInterna
     = 0

$margesq


        protected
            int
    $margesq
     = 2

$marginf


        protected
            int
    $marginf
     = 2

$margsup


        protected
            int
    $margsup
     = 2

$maxH


        protected
            float
    $maxH

$maxW


        protected
            float
    $maxW

$modal


        protected
            mixed
    $modal

$moto


        protected
            mixed
    $moto

$nApol


        protected
            mixed
    $nApol

$nomeDesenvolvedor


        protected
            mixed
    $nomeDesenvolvedor

$numdepec


        protected
            string
    $numdepec

$ObsCont


        protected
            mixed
    $ObsCont

$ObsFisco


        protected
            mixed
    $ObsFisco

$orientacao


        protected
            string
    $orientacao

$papel


        protected
            string|array<string|int, mixed>
    $papel
     = 'A4'

$pdf


        protected
            Pdf
    $pdf

$powered


        protected
            bool
    $powered
     = true

$preVisualizar


        protected
            mixed
    $preVisualizar

$protCTe


        protected
            mixed
    $protCTe

$qrCodMDFe


        protected
            mixed
    $qrCodMDFe

$respSeg


        protected
            mixed
    $respSeg

$rodo


        protected
            mixed
    $rodo

$seg


        protected
            mixed
    $seg

$siteDesenvolvedor


        protected
            mixed
    $siteDesenvolvedor

$textoAdic


        protected
            mixed
    $textoAdic
     = ''

$toma


        protected
            mixed
    $toma

$toma03


        protected
            mixed
    $toma03

$toma4


        protected
            mixed
    $toma4

$totPag


        protected
            mixed
    $totPag

$tpAmb


        protected
            mixed
    $tpAmb

$tpCTe


        protected
            mixed
    $tpCTe

$tpEmis


        protected
            mixed
    $tpEmis

$tpImp


        protected
            mixed
    $tpImp

$veic


        protected
            mixed
    $veic

$vPrest


        protected
            mixed
    $vPrest

$wAdic


        protected
            mixed
    $wAdic
     = 150

$wCanhoto


        protected
            mixed
    $wCanhoto

$wPrint


        protected
            float
    $wPrint

$xIni


        protected
            float
    $xIni

$xml


        protected
            mixed
    $xml

$xSeg


        protected
            mixed
    $xSeg

$yDados


        protected
            mixed
    $yDados
     = 0

$yIni


        protected
            float
    $yIni

__construct()

__construct


    public
                    __construct(string $xml) : mixed

Parameters

$xml : string: Arquivo XML da CTeOS

creditsIntegratorFooter()

Add the credits to the integrator in the footer message


    public
                    creditsIntegratorFooter([string $message = '' ][, bool $powered = true ]) : void

Parameters

$message : string = '': Mensagem do integrador a ser impressa no rodapé das paginas
$powered : bool = true

debugMode()

Ativa ou desativa o modo debug


    public
                    debugMode([bool $activate = null ]) : bool

Parameters

$activate : bool = null: Ativa ou desativa o modo debug

Return values

bool

depecNumber()

Numero DPEC


    public
                    depecNumber(string $numdepec) : void

Parameters

$numdepec : string

logoParameters()

Set logo e sua posição


    public
                    logoParameters(string $logo[, string $logoAlign = null ][, bool $mode_bw = false ]) : void

Parameters

$logo : string
$logoAlign : string = null
$mode_bw : bool = false: se true converte a imagem em branco e preto

printParameters()

Define parametros de impressão


    public
                    printParameters([string $orientacao = '' ][, string $papel = 'A4' ][, int $margSup = 2 ][, int $margEsq = 2 ]) : void

Parameters

$orientacao : string = ''
$papel : string = 'A4'
$margSup : int = 2
$margEsq : int = 2

render()

Renderiza o pdf e retorna como raw


    public
                    render([string $logo = '' ]) : string

Parameters

$logo : string = ''

Return values

string

setCancelFlag()

Atribui uma sinalização de cancelamento externa


    public
                    setCancelFlag([bool $cancelFlag = true ]) : mixed

Parameters

$cancelFlag : bool = true

setDefaultDecimalPlaces()

Seta o numero de casas decimais a serem usadas como padrão


    public
                    setDefaultDecimalPlaces(int $dec) : mixed

Parameters

$dec : int

setDefaultFont()

Seta a fonte padrão é times


    public
                    setDefaultFont([string $font = 'times' ]) : mixed

Parameters

$font : string = 'times'

toDateTime()

Converte data da NFe YYYY-mm-ddThh:mm:ss-03:00 para \DateTime


    public
                    toDateTime(string $input) : DateTime|false

Parameters

$input : string

Return values

DateTime|false

toTimestamp()

Converte data da NFe YYYY-mm-ddThh:mm:ss-03:00 para timestamp unix


    public
                    toTimestamp(string $input) : int

Parameters

$input : string

Return values

int

adjustImage()

Ajusta a imagem do logo


    protected
                    adjustImage(string $logo[, bool $turn_bw = false ]) : string

Parameters

$logo : string
$turn_bw : bool = false

Return values

string

cabecalho()

cabecalho Monta o cabelhalho da DACTE ( retrato e paisagem )


    protected
                    cabecalho([number $x = 0 ][, number $y = 0 ][, number $pag = '1' ][, number $totPag = '1' ]) : number

Parameters

$x : number = 0: Posição horizontal inicial, canto esquerdo
$y : number = 0: Posição vertical inicial, canto superior
$pag : number = '1': Número da Página
$totPag : number = '1': Total de páginas

Return values

number —

Posição vertical final

canhoto()

canhoto Monta o campo com os dados do remetente na DACTE.


    protected
                    canhoto([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

compValorServ()

compValorServ Monta o campo com os componentes da prestação de serviços.


    protected
                    compValorServ([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

convertUnidTrafego()

convertUnidTrafego Converte a imformação de peso contida na CTe


    protected
                    convertUnidTrafego([string $U = '' ]) : string

Parameters

$U : string = '': Informação de trafego extraida da CTe

Return values

string

dadosAdic()

dadosAdic Coloca o grupo de dados adicionais da DACTE.


    protected
                    dadosAdic(number $x, number $y, mixed $pag, number $h) : number

Parameters

$x : number: Posição horizontal canto esquerdo
$y : number: Posição vertical canto superior
$pag : mixed
$h : number: altura do campo

Return values

number —

Posição vertical final

docCompl()

docCompl Monta o campo com os dados do remetente na DACTE.


    protected
                    docCompl([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

formatCNPJCPF()

formatCNPJCPF Formata campo CnpjCpf contida na CTe


    protected
                    formatCNPJCPF(string $field) : string

Parameters

$field : string: campo cnpjCpf da CT-e

Return values

string

formatField()

Função de formatação de strings onde o cerquilha # é um coringa que será substituido por digitos contidos em campo.


    protected
                    formatField([string $campo = '' ][, string $mascara = '' ]) : string

Parameters

$campo : string = '': String a ser formatada
$mascara : string = '': Regra de formatção da string (ex. ##.###.###/####-##)

Return values

string —

Retorna o campo formatado

formatFone()

formatFone Formata campo fone contida na CTe


    protected
                    formatFone(string $field) : string

Parameters

$field : string: campo fone da CT-e

Return values

string

geraChaveAdicCont()

geraChaveAdicCont


    protected
                    geraChaveAdicCont() : string

Return values

string —

chave

getTagDate()

Recupera e reformata a data do padrão da NFe para dd/mm/aaaa


    protected
                    getTagDate(DOM $theObj, string $keyName[, string $extraText = '' ]) : string

Parameters

$theObj : DOM
$keyName : string: identificador da TAG do xml
$extraText : string = '': prefixo do retorno

Return values

string

getTagValue()

Extrai o valor do node DOM


    protected
                    getTagValue(object $theObj, string $keyName[, string $extraTextBefore = '' ][, mixed $extraTextAfter = '' ][, mixed $itemNum = 0 ]) : string

Parameters

$theObj : object: Instancia de DOMDocument ou DOMElement
$keyName : string: identificador da TAG do xml
$extraTextBefore : string = '': prefixo do retorno
$extraTextAfter : mixed = ''
$itemNum : mixed = 0

Return values

string

impostos()

impostos Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )


    protected
                    impostos([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

infPrestacaoServico()

infPrestacaoServico Monta o campo com das informações da prestação do serviço


    protected
                    infPrestacaoServico([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

modalAereo()

modalAereo Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )


    protected
                    modalAereo([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

modalAquaviario()

modalAquaviario Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )


    protected
                    modalAquaviario([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

modalFerr()

modalFerr Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )


    protected
                    modalFerr([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

modalRod()

modalRod Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )


    protected
                    modalRod([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

modulo11()

camcula digito de controle modulo 11


    protected
                    modulo11([string $numero = '' ]) : int

Parameters

$numero : string = ''

Return values

int —

modulo11 do numero passado

monta()

montaDACTE Esta função monta a DACTE conforme as informações fornecidas para a classe durante sua construção.


    protected
                    monta([string $logo = '' ]) : string

A definição de margens e posições iniciais para a impressão são estabelecidas no pelo conteúdo da funçao e podem ser modificados.

Parameters

$logo : string = ''

Return values

string —

O ID da NFe numero de 44 digitos extraido do arquivo XML

multiUniPeso()

multiUniPeso Fornece a imformação multiplicação de peso contida na CTe


    protected
                    multiUniPeso([interger $U = '' ]) : interger

Parameters

$U : interger = '': Informação de peso extraida da CTe

Return values

interger

observacoes()

observacoes Monta o campo com os dados do remetente na DACTE.


    protected
                    observacoes([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

qrCodeDacteOs()


    protected
                    qrCodeDacteOs([mixed $y = 0 ]) : mixed

Parameters

$y : mixed = 0

rodape()

rodapeDACTE Monta o rodape no final da DACTE ( retrato e paisagem )


    protected
                    rodape(mixed $x, mixed $y) : mixed

Parameters

$x : mixed
$y : mixed

seguro()

seguro Monta o campo com os dados de seguro do CT-e OS.


    protected
                    seguro([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

statusCTe()

Verifica o status da CTe


    protected
                    statusCTe() : array<string|int, mixed>

Return values

array<string|int, mixed>

tipoPag()


    protected
                    tipoPag(mixed $tPag) : mixed

Parameters

$tPag : mixed

tomador()

tomador Monta o campo com os dados do remetente na DACTE. ( retrato e paisagem )


    protected
                    tomador([number $x = 0 ][, number $y = 0 ]) : number

Parameters

$x : number = 0: Posição horizontal canto esquerdo
$y : number = 0: Posição vertical canto superior

Return values

number —

Posição vertical final

unidade()

unidade Converte a imformação de peso contida na CTe


    protected
                    unidade([string $c = '' ]) : string

Parameters

$c : string = '': unidade de trafego extraida da CTe

Return values

string

ymdTodmy()

Converte datas no formato YMD (ex. 2009-11-02) para o formato brasileiro 02/11/2009)


    protected
                    ymdTodmy([string $data = '' ]) : string

Parameters

$data : string = '': Parâmetro extraido da NFe

Return values

string —

Formatada para apresentação da data no padrão brasileiro

loadDoc()


    private
                    loadDoc(mixed $xml) : mixed

Parameters

$xml : mixed

DacteOS extends DaCommon in package Application

Table of Contents

Properties

Methods

Properties

$aereo

$aFont

$aquav

$arrayNFe

$cancelFlag

$chaveCTeRef

$Comp

$compl

$creditos

$cteProc

$debugmode

$decimalPlaces

$dom

$emit

$enderEmit

$enderToma

$errMsg

$errStatus

$ferrov

$flagDocOrigContinuacao

$fontePadrao

$formatNegrito

$formatoChave

$formatPadrao

$hPrint

$ICMS

$ICMSSN

$idDocAntEle

$ide

$imp

$infCarga

$infCte

$infCteComp

$infNF

$infNFe

$infOutros

$infPercurso

$infQ

$infServico

$infTribFed

$logoAlign

$logomarca

$lota

$margemInterna

$margesq

$marginf

$margsup

$maxH

$maxW

$modal

$moto

$nApol

$nomeDesenvolvedor

$numdepec

$ObsCont

$ObsFisco

$orientacao

$papel

$pdf

$powered

$preVisualizar

$protCTe

$qrCodMDFe

$respSeg

$rodo

$seg

$siteDesenvolvedor

$textoAdic

$toma

$toma03

$toma4

$totPag

$tpAmb

$tpCTe

$tpEmis

DacteOS extends DaCommon
in package

Application